Skip to content

[Documentation:Developer] Add testing guide for external devs #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lavalleeale
Copy link

Added a page under testing to explain to process of running workflows as an external contributor

@github-project-automation github-project-automation bot moved this to Seeking Reviewer in Submitty Development Apr 1, 2025
@lavalleeale lavalleeale changed the title [Documentation:Developer] Add guide for external contributors to trigger workflows [Documentation:Developer] Add testing guide for external devs Apr 1, 2025
@lavalleeale lavalleeale self-assigned this Apr 1, 2025
@martig7 martig7 self-requested a review April 10, 2025 23:41
Copy link

@martig7 martig7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reads well to me, not sure how to verify it looks good on the site itself.

Copy link
Contributor

@zacharymnp zacharymnp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is reasonable. I see no issues with it.

@github-project-automation github-project-automation bot moved this from Seeking Reviewer to Awaiting Maintainer Review in Submitty Development Apr 15, 2025
@IDzyre
Copy link
Contributor

IDzyre commented Apr 15, 2025

The workflows run on PR commits, not all commits, so if you create a PR on a forked repository to that same repository, it will run the github action CI workflow. However, if you want to run the workflow just on a branch that is not a PR, you have to run the workflow manually. It is the same with the main repo.

That being said, I see no real problems with this being added, however I think adding something to do with CI to either the title, or somewhere at the top to distinguish this from running tests locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Awaiting Maintainer Review
Development

Successfully merging this pull request may close these issues.

4 participants